/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *    https://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 */
package org.grails.datastore.rx.collection

import groovy.transform.CompileStatic
import groovy.transform.Generated

import rx.Observable
import rx.Subscriber
import rx.Subscription

import grails.gorm.rx.collection.ObservableCollection

/**
 * A trait that can be implemented by collection types to make them observable
 *
 * @author Graeme Rocher
 * @since 6.0
 */
@CompileStatic
trait RxCollection<T> implements ObservableCollection<T>{

    /**
     * The underlying observable
     */
    Observable observable

    /**
     * @return A list observable
     */
    @Generated
    Observable<List> toListObservable() {
        observable.toList()
    }

    @Generated
    Observable toObservable() {
        return this.observable
    }

    @Generated
    Subscription subscribe(Subscriber subscriber) {
        return observable.subscribe(subscriber)
    }
}
